home *** CD-ROM | disk | FTP | other *** search
/ Aminet 21 / Aminet 21 (1997)(GTI - Schatztruhe)[!][Oct 1997].iso / Aminet / comm / www / HTTX.lha / AWeb / HTTXPlugin.doc < prev    next >
Text File  |  1997-07-16  |  6KB  |  203 lines
  1.                     HTTXPlugin: HTTX-AWeb Interface V2.0
  2.  
  3.                                      by
  4.                   AmiTrix Development (support@amitrix.com)
  5.                      and Gabriele Favrin (favrin@tin.it)
  6.  
  7. -----------------------------------------------------------------------------
  8.  
  9. THE  AUTHORS ARE IN NO WAY RESPONSIBLE FOR ANY DAMAGE THAT THESE PROGRAMS MAY
  10. CAUSE.
  11.  
  12. These   files  are  included  in  HTTX  distribution  with  explicit  AmiTrix
  13. permission.   Redistribution  or  modification are forbidden.  If you improve
  14. these scripts just send me (favrin@tin.it) the new version.
  15.  
  16. -----------------------------------------------------------------------------
  17.  
  18. With HTTXPlugin you can use HTTX from AWeb to save (or print) HTML pages as
  19. text.  This version of the interface requires AWeb II 3.0 or better and HTTX
  20. 1.5 or better.  Also, the command "Delete" must be present in C:  directory.
  21.  
  22.  
  23. How to install
  24. --------------
  25.  
  26. - Copy:
  27.  
  28.   HTTXPlugin.awebrx
  29.   HTTXPluginCFG.awebrx
  30.   HTTXPluginPRT.awebrx
  31.   HTTX                  <-- yes, also the HTTX executable!
  32.   HTTXPlugin.doc and HTTXPlugin.doc.html (for online help)
  33.  
  34.   ALL to the AWeb/Plugins/HTTX directory.
  35.  
  36. - Load AWeb, open "Program settings/Options" requester and set the
  37.   "Allow Shell commands in links" option.  This is required for
  38.   HTTXPluginCFG.awebrx.
  39.  
  40. - To integrate AWeb and HTTX you can use ARexx menu, fastlinks and/or popup
  41.   menu.  Suggested additions are:
  42.  
  43.   ARexx menu and/or fastlinks:
  44.  
  45.   add three entries, one for Save as text (HTTXPlugin.awebrx), one for Print
  46.   as text (HTTXPluginPRT.awebrx) and one for the HTTX and plugin
  47.   configuration (HTTXPluginCFG.awebrx).
  48.  
  49.   Popup menu (frame):
  50.  
  51.   add entries Save As Text and Print As Text (if required) using as command:
  52.  
  53.   for save:
  54.   Plugins/HTTX/HTTXPlugin.awebrx TARGET %i
  55.  
  56.   for print:
  57.   Plugins/HTTX/HTTXPluginPRT.awebrx TARGET %i
  58.  
  59.   In this way it will be possible to save or print a single frame directly
  60.   from the popup menu without need to select it via the plugin "Select
  61.   frame(s)" function.
  62.  
  63.  
  64. How to config
  65. -------------
  66.  
  67. First you have to setup configuration.
  68. Load HTTXPluginCFG.awebrx and set the various options:
  69.  
  70.  
  71.                     HTML conversion related configuration
  72.  
  73. Default Directory
  74.    Default directory to save converted files
  75.  
  76. Line length
  77.    Maximum length for each line.
  78.  
  79.    Equals to option LEN
  80.  
  81. Indentation
  82.    Number of spaces for indentation (re-enter to the right) of the
  83.    <UL> and <DL> lists.
  84.  
  85.    Equals to option INDENT
  86.  
  87. ANSI conversion of styles and links
  88.    ANSI conversion of HTML styles and LINKS.
  89.  
  90.    Equals to option ANSI
  91.  
  92. Conversion of entities to 7 bit ascii
  93.    Conversion of HTML entities (accent letters, and so) to ASCII codes lower
  94.    than 128.
  95.  
  96.    Equals to option 7BIT
  97.  
  98. HR draw mode
  99.    Set type of lines drawed when encountering <HR> tag.
  100.  
  101.    Off:   no lines
  102.    ASCII: lines composed by "-"
  103.    ANSI:  lines composed by underlined spaces
  104.  
  105.    Equals to option HRMODE=nn
  106.  
  107. Ignore text and HR alignment
  108.    Don't centre/align right text and lines.
  109.  
  110.    Equals to option NOALIGN
  111.  
  112. Save Title as FileNote
  113.    Saves the document title (<TITLE>) as output file comment.
  114.    Only used when saving as text.
  115.  
  116.    Equals to option FILENOTE
  117.  
  118. Suppress Title/URL
  119.    Suppresses insertion of document Title (<TITLE>) and URL in converted
  120.    file.
  121.  
  122.    Equals to option NOHEADER if set, GETNOTE if not set.
  123.  
  124. Print HTML Link References
  125.    Adds HTML link references to converted file.
  126.  
  127.    Equals to option HREF
  128.  
  129. Print Image Alternate Texts
  130.    Adds the ALT-text of images (<IMG>) to converted file.
  131.  
  132.    Equals to option IMG
  133.  
  134. Support badly written HTML
  135.    Partial support for badly written HTML documents.  Use with caution!
  136.  
  137.    Equals to option BADHTML
  138.  
  139. These settings will be saved in the environment vars HTTX.prefs (for Save as
  140. text) and HTTXprt.prefs (for Print as text).
  141.  
  142. Other options (like FORCE) are managed directly from the Plugin.
  143. Refer to HTTX documentation for full explanation of options.
  144.  
  145.  
  146.                         Plugin related configuration
  147.  
  148. Print HTTP/META header
  149.    Adds the header informations received by AWeb from server when getting
  150.    the document and the meta tags present in the HTML source to converted
  151.    file.
  152.  
  153.    Example of the added text:
  154.  
  155.    Header:
  156.    HTTP/1.0 200 OK
  157.    Server: Netscape-Enterprise/2.01
  158.    Date: Sat, 26 Apr 1997 06:38:12 GMT
  159.    Accept-ranges: bytes
  160.    Last-modified: Tue, 15 Apr 1997 13:57:46 GMT
  161.    Content-length: 7085
  162.    Content-type: text/html
  163.    Content-Type: text/html; charset=ISO-8859-1
  164.  
  165. Show preview of converted document
  166.    With this option after converting a document it will be showed (using
  167.    Multiview that must be in SYS:Utilities/ drawer).  After closing Multiview
  168.    a requester will ask if the document should be kept or deleted.
  169.    Selecting Delete the file will be erased and no conversion informations
  170.    will be showed.
  171.  
  172.    This option is only used when saving as text.
  173.  
  174. Show conversion report
  175.    After converting a document, an info page containing current settings
  176.    of HTTX is normally showen.  You can set within this and just a requester
  177.    that reports if conversion has been succesful.
  178.  
  179. These settings will be saved in the environment variable HTTXPlugin.config.
  180.  
  181.  
  182. HTTXPlugin works as the standard preference programs, so you can use Save or
  183. Use option to store data.  With "Save" the settings are stored in ENVARC:
  184. and then keeped for other sessions.  With "Use" only in ENV: so they are
  185. lost when resetting computer.  Obviously first time you have to use "Save"
  186. option.
  187.  
  188.  
  189. How to use
  190. ----------
  191.  
  192. For saving or printing a page just use the previously set menu or popup
  193. entries).
  194.  
  195. If page contains frames a requester will be popup.  You can choose to save
  196. all frames to a single file or to select which ones.  In this case all frames
  197. will be shown and a requester will ask to save or skip it.
  198.  
  199. When saving, after conversion of any document, if it's active, document will
  200. be shown and then with a requester will be possible to keep or delete it.
  201.  
  202. -----------------------------------------------------------------------------
  203.